formats: Added descriptive text for the few remaining undocumented formats

formats/options: Documented various options (mostly with the awesome power
                 of 'cp'.)

diff --git a/xmldoc/formats/arc.xml b/xmldoc/formats/arc.xml
index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..a10c27ad1ab89a0e7e110f63549444a86c2600cb 100644 (file)
--- a/xmldoc/formats/arc.xml
+++ b/xmldoc/formats/arc.xml
@@ -0,0 +1,6 @@
+<para>
+This format is used by GPSBabel itself as the input to the 
+<link linkend="filter_arc">arc</link> and 
+<link linkend="filter_polygon">polygon</link> filters.  See those filters
+for more information.
+</para>

diff --git a/xmldoc/formats/custom.xml b/xmldoc/formats/custom.xml
index 8b137891791fe96927ad78e64b0aad7bded08bdc..40cbece72b57e0615c356cc71ad44fe67f3fd875 100644 (file)
--- a/xmldoc/formats/custom.xml
+++ b/xmldoc/formats/custom.xml
@@ -1 +1,9 @@
-
+<para>
+This format is not actually used by any real product.  It is most useful
+for debugging purposes when developing a new format module for GPSBabel.
+</para>
+<para>
+To understand the contents of this file, look at the 
+<filename>style/custom.style</filename> file in the GPSBabel source
+distribution as well as the <link linkend="app_styles">appendix</link>.
+</para>

diff --git a/xmldoc/formats/options/cetus-appendicon.xml b/xmldoc/formats/options/cetus-appendicon.xml
index 8b137891791fe96927ad78e64b0aad7bded08bdc..9a52e4eefe43c362823ce1a633e6e5ca3a023556 100644 (file)
--- a/xmldoc/formats/options/cetus-appendicon.xml
+++ b/xmldoc/formats/options/cetus-appendicon.xml
@@ -1 +1,7 @@
-
+<para>
+This option will add the icon description to the end of the waypoint
+description on output.  This can be useful if the icon is used to convey
+important information about the waypoint.  For example, the icon might be 
+"found geocache" or "unfound geocache"; it might be useful to know that when
+looking at a list of icons in Cetus.
+</para>

diff --git a/xmldoc/formats/options/cetus-dbname.xml b/xmldoc/formats/options/cetus-dbname.xml
index 8b137891791fe96927ad78e64b0aad7bded08bdc..f4b336e5e20900c6d105ec84b052862b32d94500 100644 (file)
--- a/xmldoc/formats/options/cetus-dbname.xml
+++ b/xmldoc/formats/options/cetus-dbname.xml
@@ -1 +1,6 @@
+<para>
+This option specifies the database name for the output file.  This name is
+not the same thing as the file name on your computer; this is the name that
+appears in the file browser on your handheld.
+</para>
 

diff --git a/xmldoc/formats/options/geoniche-dbname.xml b/xmldoc/formats/options/geoniche-dbname.xml
index 8b137891791fe96927ad78e64b0aad7bded08bdc..f4b336e5e20900c6d105ec84b052862b32d94500 100644 (file)
--- a/xmldoc/formats/options/geoniche-dbname.xml
+++ b/xmldoc/formats/options/geoniche-dbname.xml
@@ -1 +1,6 @@
+<para>
+This option specifies the database name for the output file.  This name is
+not the same thing as the file name on your computer; this is the name that
+appears in the file browser on your handheld.
+</para>
 

diff --git a/xmldoc/formats/options/gpilots-dbname.xml b/xmldoc/formats/options/gpilots-dbname.xml
index 8b137891791fe96927ad78e64b0aad7bded08bdc..f4b336e5e20900c6d105ec84b052862b32d94500 100644 (file)
--- a/xmldoc/formats/options/gpilots-dbname.xml
+++ b/xmldoc/formats/options/gpilots-dbname.xml
@@ -1 +1,6 @@
+<para>
+This option specifies the database name for the output file.  This name is
+not the same thing as the file name on your computer; this is the name that
+appears in the file browser on your handheld.
+</para>
 

diff --git a/xmldoc/formats/options/gpspilot-dbname.xml b/xmldoc/formats/options/gpspilot-dbname.xml
index 8b137891791fe96927ad78e64b0aad7bded08bdc..f4b336e5e20900c6d105ec84b052862b32d94500 100644 (file)
--- a/xmldoc/formats/options/gpspilot-dbname.xml
+++ b/xmldoc/formats/options/gpspilot-dbname.xml
@@ -1 +1,6 @@
+<para>
+This option specifies the database name for the output file.  This name is
+not the same thing as the file name on your computer; this is the name that
+appears in the file browser on your handheld.
+</para>
 

diff --git a/xmldoc/formats/options/gpx-gpxver.xml b/xmldoc/formats/options/gpx-gpxver.xml
index 8b137891791fe96927ad78e64b0aad7bded08bdc..4571bd7fb36fe9eb84a7962a40e87c4d64a2b8af 100644 (file)
--- a/xmldoc/formats/options/gpx-gpxver.xml
+++ b/xmldoc/formats/options/gpx-gpxver.xml
@@ -1 +1,6 @@
+<para>
+This option specifies the version of the GPX specification to use for 
+output.  The default version is 1.0.  The only other valid value for this
+option is 1.1.
+</para>
 

diff --git a/xmldoc/formats/options/pathaway-dbname.xml b/xmldoc/formats/options/pathaway-dbname.xml
index 8b137891791fe96927ad78e64b0aad7bded08bdc..f4b336e5e20900c6d105ec84b052862b32d94500 100644 (file)
--- a/xmldoc/formats/options/pathaway-dbname.xml
+++ b/xmldoc/formats/options/pathaway-dbname.xml
@@ -1 +1,6 @@
+<para>
+This option specifies the database name for the output file.  This name is
+not the same thing as the file name on your computer; this is the name that
+appears in the file browser on your handheld.
+</para>
 

diff --git a/xmldoc/formats/options/quovadis-dbname.xml b/xmldoc/formats/options/quovadis-dbname.xml
index 8b137891791fe96927ad78e64b0aad7bded08bdc..f4b336e5e20900c6d105ec84b052862b32d94500 100644 (file)
--- a/xmldoc/formats/options/quovadis-dbname.xml
+++ b/xmldoc/formats/options/quovadis-dbname.xml
@@ -1 +1,6 @@
+<para>
+This option specifies the database name for the output file.  This name is
+not the same thing as the file name on your computer; this is the name that
+appears in the file browser on your handheld.
+</para>
 

diff --git a/xmldoc/formats/tabsep.xml b/xmldoc/formats/tabsep.xml
index 8b137891791fe96927ad78e64b0aad7bded08bdc..42c6c113673f4cd649f08a43d662748221ebc375 100644 (file)
--- a/xmldoc/formats/tabsep.xml
+++ b/xmldoc/formats/tabsep.xml
@@ -1 +1,13 @@
+<para>
+This format, like the <link linkend="fmt_custom">custom</link> format, is
+mainly used for the purpose of testing GPSBabel.  It is supposed to contain
+one field for each piece of information supported by the 
+<link linkend="fmt_xcsv">xcsv</link> format writer, but it may not be entirely
+in sync with the <link linkend="app_styles">appendix</link> that describes 
+those fields.
+</para>
+<para>
+For a list of fields, see the style/tabsep.style file in the GPSBabel source
+distribution.
+</para>
 

diff --git a/xmldoc/formats/xcsv.xml b/xmldoc/formats/xcsv.xml
index 8b137891791fe96927ad78e64b0aad7bded08bdc..5b695d7930a635a1562e547cfc5f09c5bcfe1ae6 100644 (file)
--- a/xmldoc/formats/xcsv.xml
+++ b/xmldoc/formats/xcsv.xml
@@ -1 +1,13 @@
+<para>
+This format is a very flexible module that can be used to read or write 
+nearly any plain-text record-based waypoint file.  This flexibility is 
+achieved with "style" files that describe the format of the waypoint files.
+</para>
+<para>
+There are several formats built in to GPSBabel that use the underlying xcsv 
+machinery.  Each of those formats takes the same options as the xcsv format,
+with the obvious exception of the <option>style</option> option.  
+Those formats are all based on style files that can be found in 
+the "style" directory in the GPSBabel source distribution.
+</para>